{% extends "IncetOps/base/base.html" %}

{% block title %}帮助{% endblock %}

{% block head %}
    <link rel="stylesheet" href="{{ url_for('static', filename='IncetOps/css/public.css') }}" media="all" />
    <style type="text/css">
        pre, kbd, code{font-family:"Microsoft Yahei","Hiragino Sans GB","Helvetica Neue",Helvetica,tahoma,arial,Verdana,sans-serif,"WenQuanYi Micro Hei","\5B8B\4F53";font-size:12px;color: #333;-webkit-font-smoothing: antialiased;-moz-osx-font-smoothing:grayscale}
    </style>
{% endblock %}

{% block page %}
<div class="layui-fluid">
    <!--demo
    <fieldset class="layui-elem-field layui-field-title">
        <legend>问题</legend>
        <div class="layui-field-box">
            <pre class="layui-code"><p>回答</p></pre>
        </div>
    </fieldset>
    -->
    <fieldset class="layui-elem-field layui-field-title">
        <legend>MySQL数据库设计规范</legend>
        <div class="layui-field-box">
            <pre class="layui-code"><a href="javascript:;" id="mdds">参考第三方规范，点击查看</a></pre>
        </div>
    </fieldset>
    <fieldset class="layui-elem-field layui-field-title">
        <legend>Inception审核规范及原则</legend>
        <div class="layui-field-box">
            <pre class="layui-code">请跳转到Inception审核规范页查询阅读：<a href="https://mysql-inception.github.io/inception-document/rules/" target="_blank">https://mysql-inception.github.io/inception-document/rules/</a></pre>
        </div>
    </fieldset>
    <fieldset class="layui-elem-field layui-field-title">
        <legend>Inception对线上配置需求</legend>
        <div class="layui-field-box">
            <pre class="layui-code">1. 线上服务器必须要打开 binlog，在启动时需要设置参数log_bin、log_bin_index等关于 binlog 的参数。不然不会备份及生成回滚语句。<br>2. 参数binlog_format必须要设置为 mixed 或者 row 模式，通过语句： set global binlog_format=mixed/row 来设置，如果是 statement 模式，则不做备份及回滚语句的生成。<br>3. 参数 server_id 必须要设置为非0及非1，通过语句：set global server_id=server_id;来设置，不然在备份时会报错。<br>4. 线上服务器一定要有指定用户名的权限，这个是在语句前面的注释中指定的，做什么操作就要有什么权限，否则还是会报错，如果需要执行的功能，则要有线上执行语句的权限，比如DDL及DML，同时如果要执行inception show 等远程命令的话，有些语句是需要特殊权限的，这些权限也是需要授予的，关于权限这个问题，因为一般Inception是运行在一台固定机器上面的，那么在选项中指定的用户名密码，实际上是Inception机器对线上数据库访问的权限，所以建议在使用过程中，使用专门固定的帐号来让Inception使用，最好是一个只读一个可写的即可，这样在执行时用可写，审核或者查看线上状态或者表库结果时用只读即可，这样更安全。<br>5. <b style="color: red">需要额外注意的点</b>: 在执行时，不能将 DML 语句及 DDL 语句放在一起执行，否则会因为备份解析binlog时由于表结构的变化出现不可预知的错误，如果要有同时执行 DML 及 DDL，则请分开多个语句块儿来执行，如果真的这样做了，Inception 会报错，不会去执行。</pre>
        </div>
    </fieldset>
    <fieldset class="layui-elem-field layui-field-title">
        <legend>查看回滚(备份功能)</legend>
        <div class="layui-field-box">
            <pre class="layui-code">1. Inception配置文件支持备份(设置备份参数并有权限操作备份库)<br>2. 任务开启备份选项<br>3. 被影响的表要存在主键<br>4. 参考`Inception对线上配置需求`</pre>
        </div>
    </fieldset>
</div>
{% endblock %}

{% block script %}
<script type="text/javascript">
    layui.use(['incetops', 'layer'], function() {
        var $ = layui.$,
            layer = layui.layer,
            incetops = layui.incetops;
        $("#mdds").click(function() {
            var content = ['<div style="padding: 20px;"><pre class="layui-code"><code>1. 规范背景与目的<br>',
                '2. 设计规范<br>',
                '2.1 数据库设计<br>',
                '2.1.1 库名<br>',
                '2.1.2 表结构<br>',
                '2.1.3 列数据类型优化<br>',
                '2.1.4 索引设计<br>',
                '2.1.5 分库分表、分区表<br>',
                '2.1.6 字符集<br>',
                '2.1.7 程序DAO层设计建议<br>',
                '2.1.8 一个规范的建表语句示例<br>',
                '2.2 SQL编写<br>',
                '2.2.1 DML语句<br>',
                '2.2.2 多表连接<br>',
                '2.2.3 事务<br>',
                '2.2.4 排序和分组<br>',
                '2.2.5 线上禁止使用的SQL语句<br></code></pre><h2>1.规范背景与目的</h2><p>MySQL数据库与Oracle、SQL Server等数据库相比，有其内核上的优势与劣势。我们在使用MySQL数据库的时候需要遵循一定规范，扬长避短。本规范旨在帮助或指导RD、QA、OP等技术人员做出适合线上业务的数据库设计。在数据库变更和处理流程、数据库表设计、SQL编写等方面予以规范，从而为公司业务系统稳定、健康地运行提供保障。</p><h2>2.设计规范</h2><h3>2.1数据库设计</h3><p>以下所有规范会按照【高危】、【强制】、【建议】三个级别进行标注，遵守优先级从高到低。</p><p>对于不满足【高危】和【强制】两个级别的设计，DBA会强制打回要求修改。</p><h3>2.1.1库名</h3><ol><li>【强制】库的名称必须控制在32个字符以内，相关模块的表名与表名之间尽量提现join的关系，如user表和user_login表。</li><li>【强制】库的名称格式：业务系统名称_子系统名，同一模块使用的表名尽量使用统一前缀。</li><li>【强制】一般分库名称命名格式是<code>库通配名_编号</code>，编号从0开始递增，比如<code>wenda_001</code>以时间进行分库的名称格式是“库通配名_时间”</li><li>【强制】创建数据库时必须显式指定字符集，并且字符集只能是utf8或者utf8mb4。创建数据库SQL举例：<code>create database db1 default character set utf8;</code>。</li></ol><h3>2.1.2表结构</h3><ol><li>【强制】表和列的名称必须控制在32个字符以内，表名只能使用字母、数字和下划线，一律小写。</li><li>【强制】表名要求模块名强相关，如师资系统采用”sz”作为前缀，渠道系统采用”qd”作为前缀等。</li><li>【强制】创建表时必须显式指定字符集为utf8或utf8mb4。</li><li>【强制】创建表时必须显式指定表存储引擎类型，如无特殊需求，一律为InnoDB。当需要使用除InnoDB/MyISAM/Memory以外的存储引擎时，必须通过DBA审核才能在生产环境中使用。因为Innodb表支持事务、行锁、宕机恢复、MVCC等关系型数据库重要特性，为业界使用最多的MySQL存储引擎。而这是其他大多数存储引擎不具备的，因此首推InnoDB。</li><li>【强制】建表必须有comment</li><li>【建议】建表时关于主键：(1)强制要求主键为id，类型为int或bigint，且为<code>auto_increment(2)</code>标识表里每一行主体的字段不要设为主键，建议设为其他字段如<code>user_id</code>，<code>order_id</code>等，并建立unique key索引（可参考<code>cdb.teacher</code>表设计）。因为如果设为主键且主键值为随机插入，则会导致innodb内部page分裂和大量随机I/O，性能下降。</li><li>【建议】核心表（如用户表，金钱相关的表）必须有行数据的创建时间字段<code>create_time</code>和最后更新时间字段<code>update_time</code>，便于查问题。</li><li>【建议】表中所有字段必须都是<code>NOT NULL</code>属性，业务可以根据需要定义<code>DEFAULT</code>值。因为使用NULL值会存在每一行都会占用额外存储空间、数据迁移容易出错、聚合函数计算结果偏差等问题。</li><li>【建议】建议对表里的<code>blob</code>、<code>text</code>等大字段，垂直拆分到其他表里，仅在需要读这些对象的时候才去select。</li><li>【建议】反范式设计：把经常需要join查询的字段，在其他表里冗余一份。如<code>user_name</code>属性在<code>user_account</code>，<code>user_login_log</code>等表里冗余一份，减少join查询。</li><li>【强制】中间表用于保留中间结果集，名称必须以<code>tmp_</code>开头。备份表用于备份或抓取源表快照，名称必须以<code>bak_</code>开头。中间表和备份表定期清理。</li><li>【强制】对于超过100W行的大表进行<code>alter table</code>，必须经过DBA审核，并在业务低峰期执行。因为<code>alter table</code>会产生表锁，期间阻塞对于该表的所有写入，对于业务可能会产生极大影响。</li></ol><h3>2.1.3列数据类型优化</h3><ol><li>【建议】表中的自增列（<code>auto_increment</code>属性），推荐使用<code>bigint</code>类型。因为无符号<code>int</code>存储范围为<code>-2147483648~2147483647</code>（大约21亿左右），溢出后会导致报错。</li><li>【建议】业务中选择性很少的状态<code>status</code>、类型<code>type</code>等字段推荐使用<code>tinytint</code>或者<code>smallint</code>类型节省存储空间。</li><li>【建议】业务中IP地址字段推荐使用<code>int</code>类型，不推荐用<code>char(15)</code>。因为<code>int</code>只占4字节，可以用如下函数相互转换，而<code>char(15)</code>占用至少15字节。一旦表数据行数到了1亿，那么要多用1.1G存储空间。SQL：<code>select inet_aton(&#39;192.168.2.12&#39;);select inet_ntoa(3232236044);</code>PHP:<code>ip2long(‘192.168.2.12’);long2ip(3530427185);</code></li><li>【建议】不推荐使用<code>enum</code>，<code>set</code>。因为它们浪费空间，且枚举值写死了，变更不方便。推荐使用<code>tinyint</code>或<code>smallint</code>。</li><li>【建议】不推荐使用<code>blob</code>，<code>text</code>等类型。它们都比较浪费硬盘和内存空间。在加载表数据时，会读取大字段到内存里从而浪费内存空间，影响系统性能。建议和PM、RD沟通，是否真的需要这么大字段。Innodb中当一行记录超过8098字节时，会将该记录中选取最长的一个字段将其768字节放在原始page里，该字段余下内容放在<code>overflow-page</code>里。不幸的是在<code>compact</code>行格式下，原始<code>page</code>和<code>overflow-page</code>都会加载。</li><li>【建议】存储金钱的字段，建议用<code>int</code>，程序端乘以100和除以100进行存取。因为<code>int</code>占用4字节，而<code>double</code>占用8字节，空间浪费。</li><li>【建议】文本数据尽量用<code>varchar</code>存储。因为<code>varchar</code>是变长存储，比<code>char</code>更省空间。MySQL server层规定一行所有文本最多存65535字节，因此在utf8字符集下最多存21844个字符，超过会自动转换为<code>mediumtext</code>字段。而<code>text</code>在utf8字符集下最多存21844个字符，<code>mediumtext</code>最多存2^24/3个字符，<code>longtext</code>最多存2^32个字符。一般建议用<code>varchar</code>类型，字符数不要超过2700。</li><li>【建议】时间类型尽量选取<code>timestamp</code>。因为<code>datetime</code>占用8字节，<code>timestamp</code>仅占用4字节，但是范围为<code>1970-01-01 00:00:01</code>到<code>2038-01-01 00:00:00</code>。更为高阶的方法，选用<code>int</code>来存储时间，使用SQL函数<code>unix_timestamp()</code>和<code>from_unixtime()</code>来进行转换。</li></ol><p>详细存储大小参加下图：</p><p><img alt="MySQL数据类型存储大小"src="/static/IncetOps/images/mysql_datatype.png"/></p><h3>2.1.4索引设计</h3><ol><li>【强制】InnoDB表必须主键为<code>id int/bigint auto_increment</code>,且主键值禁止被更新。</li><li>【建议】主键的名称以“<code>pk_</code>”开头，唯一键以“<code>uk_</code>”或“<code>uq_</code>”开头，普通索引以“<code>idx_</code>”开头，一律使用小写格式，以表名/字段的名称或缩写作为后缀。</li><li>【强制】InnoDB和MyISAM存储引擎表，索引类型必须为<code>BTREE</code>；MEMORY表可以根据需要选择<code>HASH</code>或者<code>BTREE</code>类型索引。</li><li>【强制】单个索引中每个索引记录的长度不能超过64KB。</li><li>【建议】单个表上的索引个数不能超过7个。</li><li>【建议】在建立索引时，多考虑建立联合索引，并把区分度最高的字段放在最前面。如列<code>userid</code>的区分度可由<code>select count(distinct userid)</code>计算出来。</li><li>【建议】在多表join的SQL里，保证被驱动表的连接列上有索引，这样join执行效率最高。</li><li>【建议】建表或加索引时，保证表里互相不存在冗余索引。对于MySQL来说，如果表里已经存在<code>key(a,b)</code>，则<code>key(a)</code>为冗余索引，需要删除。</li></ol><h3>2.1.5分库分表、分区表</h3><ol><li>【强制】分区表的分区字段（<code>partition-key</code>）必须有索引，或者是组合索引的首列。</li><li>【强制】单个分区表中的分区（包括子分区）个数不能超过1024。</li><li>【强制】上线前RD或者DBA必须指定分区表的创建、清理策略。</li><li>【强制】访问分区表的SQL必须包含分区键。</li><li>【建议】单个分区文件不超过2G，总大小不超过50G。建议总分区数不超过20个。</li><li>【强制】对于分区表执行<code>alter table</code>操作，必须在业务低峰期执行。</li><li>【强制】采用分库策略的，库的数量不能超过1024</li><li>【强制】采用分表策略的，表的数量不能超过4096</li><li>【建议】单个分表不超过500W行，ibd文件大小不超过2G，这样才能让数据分布式变得性能更佳。</li><li>【建议】水平分表尽量用取模方式，日志、报表类数据建议采用日期进行分表。</li></ol><h3>2.1.6字符集</h3><ol><li>【强制】数据库本身库、表、列所有字符集必须保持一致，为<code>utf8</code>或<code>utf8mb4</code>。</li><li>【强制】前端程序字符集或者环境变量中的字符集，与数据库、表的字符集必须一致，统一为<code>utf8</code>。</li></ol><h3>2.1.7程序层DAO设计建议</h3><ol><li>【建议】新的代码不要用model，推荐使用手动拼SQL+绑定变量传入参数的方式。因为model虽然可以使用面向对象的方式操作db，但是其使用不当很容易造成生成的SQL非常复杂，且model层自己做的强制类型转换性能较差，最终导致数据库性能下降。</li><li>【建议】前端程序连接MySQL或者redis，必须要有连接超时和失败重连机制，且失败重试必须有间隔时间。</li><li>【建议】前端程序报错里尽量能够提示MySQL或redis原生态的报错信息，便于排查错误。</li><li>【建议】对于有连接池的前端程序，必须根据业务需要配置初始、最小、最大连接数，超时时间以及连接回收机制，否则会耗尽数据库连接资源，造成线上事故。</li><li>【建议】对于log或history类型的表，随时间增长容易越来越大，因此上线前RD或者DBA必须建立表数据清理或归档方案。</li><li>【建议】在应用程序设计阶段，RD必须考虑并规避数据库中主从延迟对于业务的影响。尽量避免从库短时延迟（20秒以内）对业务造成影响，建议强制一致性的读开启事务走主库，或更新后过一段时间再去读从库。</li><li>【建议】多个并发业务逻辑访问同一块数据（innodb表）时，会在数据库端产生行锁甚至表锁导致并发下降，因此建议更新类SQL尽量基于主键去更新。</li><li>【建议】业务逻辑之间加锁顺序尽量保持一致，否则会导致死锁。</li><li>【建议】对于单表读写比大于10:1的数据行或单个列，可以将热点数据放在缓存里（如mecache或redis），加快访问速度，降低MySQL压力。</li></ol><h3>2.1.8一个规范的建表语句示例</h3><p>一个较为规范的建表语句为：</p><pre class="layui-code"><code>CREATE TABLE user (<br>',
                '  `id` bigint(11) NOT NULL AUTO_INCREMENT,<br>',
                '  `user_id` bigint(11) NOT NULL COMMENT ‘用户id’<br>',
                '  `username` varchar(45) NOT NULL COMMENT &#39;真实姓名&#39;,<br>',
                '  `email` varchar(30) NOT NULL COMMENT ‘用户邮箱’,<br>',
                '  `nickname` varchar(45) NOT NULL COMMENT &#39;昵称&#39;,<br>',
                '  `avatar` int(11) NOT NULL COMMENT &#39;头像&#39;,<br>',
                '  `birthday` date NOT NULL COMMENT &#39;生日&#39;,<br>',
                '  `sex` tinyint(4) DEFAULT &#39;0&#39; COMMENT &#39;性别&#39;,<br>',
                '  `short_introduce` varchar(150) DEFAULT NULL COMMENT &#39;一句话介绍自己，最多50个汉字&#39;,<br>',
                '  `user_resume` varchar(300) NOT NULL COMMENT &#39;用户提交的简历存放地址&#39;,<br>',
                '  `user_register_ip` int NOT NULL COMMENT ‘用户注册时的源ip’,<br>',
                '  `create_time` timestamp NOT NULL COMMENT ‘用户记录创建的时间’,<br>',
                '  `update_time` timestamp NOT NULL COMMENT ‘用户资料修改的时间’,<br>',
                '  `user_review_status` tinyint NOT NULL COMMENT ‘用户资料审核状态，1为通过，2为审核中，3为未通过，4为还未提交审核’,<br>',
                '  PRIMARY KEY (`id`),<br>',
                '  UNIQUE KEY `idx_user_id` (`user_id`),<br>',
                '  KEY `idx_username`(`username`),<br>',
                '  KEY `idx_create_time`(`create_time`,`user_review_status`)<br>',
                ') ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT=&#39;网站用户基本信息&#39;;<br></code></pre><h2>2.2 SQL编写</h2><h3>2.2.1 DML语句</h3><ol><li>【强制】SELECT语句必须指定具体字段名称，禁止写成<code>*</code>。因为<code>select*</code>会将不该读的数据也从MySQL里读出来，造成网卡压力。且表字段一旦更新，但model层没有来得及更新的话，系统会报错。</li><li>【强制】insert语句指定具体字段名称，不要写成<code>insert into t1 values(…)</code>，道理同上。</li><li>【建议】<code>insert into…values(XX),(XX),(XX)…</code>。这里XX的值不要超过5000个。值过多虽然上线很很快，但会引起主从同步延迟。</li><li>【建议】SELECT语句不要使用<code>UNION</code>，推荐使用<code>UNION ALL</code>，并且<code>UNION</code>子句个数限制在5个以内。因为<code>union all</code>不需要去重，节省数据库资源，提高性能。</li><li>【建议】in值列表限制在500以内。例如<code>select…where userid in(….500个以内…)</code>，这么做是为了减少底层扫描，减轻数据库压力从而加速查询。</li><li>【建议】事务里批量更新数据需要控制数量，进行必要的sleep，做到少量多次。</li><li>【强制】事务涉及的表必须全部是innodb表。否则一旦失败不会全部回滚，且易造成主从库同步终端。</li><li>【强制】写入和事务发往主库，只读SQL发往从库。</li><li>【强制】除静态表或小表（100行以内），DML语句必须有where条件，且使用索引查找。</li><li>【强制】生产环境禁止使用<code>hint</code>，如<code>sql_no_cache</code>，<code>force index</code>，<code>ignore key</code>，<code>straight join</code>等。因为<code>hint</code>是用来强制SQL按照某个执行计划来执行，但随着数据量变化我们无法保证自己当初的预判是正确的，因此我们要相信MySQL优化器！</li><li>【强制】where条件里等号左右字段类型必须一致，否则无法利用索引。</li><li>【建议】<code>SELECT|UPDATE|DELETE|REPLACE</code>要有WHERE子句，且WHERE子句的条件必需使用索引查找。</li><li>【强制】生产数据库中强烈不推荐大表上发生全表扫描，但对于100行以下的静态表可以全表扫描。查询数据量不要超过表行数的25%，否则不会利用索引。</li><li>【强制】WHERE子句中禁止只使用全模糊的LIKE条件进行查找，必须有其他等值或范围查询条件，否则无法利用索引。</li><li>【建议】索引列不要使用函数或表达式，否则无法利用索引。如<code>where length(name)=&#39;Admin&#39;</code>或<code>where user_id+2=10023</code>。</li><li>【建议】减少使用or语句，可将or语句优化为union，然后在各个where条件上建立索引。如<code>where a=1 or b=2</code>优化为<code>where a=1…union…where b=2,key(a),key(b)</code>。</li><li>【建议】分页查询，当limit起点较高时，可先用过滤条件进行过滤。如<code>select a,b,c from t1 limit 10000,20;</code>优化为:<code>select a,b,c from t1 where id&gt;10000 limit 20;</code>。</li></ol><h3>2.2.2多表连接</h3><ol><li>【强制】禁止跨db的join语句。因为这样可以减少模块间耦合，为数据库拆分奠定坚实基础。</li><li>【强制】禁止在业务的更新类SQL语句中使用join，比如<code>update t1 join t2…</code>。</li><li>【建议】不建议使用子查询，建议将子查询SQL拆开结合程序多次查询，或使用join来代替子查询。</li><li>【建议】线上环境，多表join不要超过3个表。</li><li>【建议】多表连接查询推荐使用别名，且SELECT列表中要用别名引用字段，数据库.表格式，如<code>select a from db1.table1 alias1 where…</code>。</li><li>【建议】在多表join中，尽量选取结果集较小的表作为驱动表，来join其他表。</li></ol><h3>2.2.3事务</h3><ol><li>【建议】事务中<code>INSERT|UPDATE|DELETE|REPLACE</code>语句操作的行数控制在2000以内，以及WHERE子句中IN列表的传参个数控制在500以内。</li><li>【建议】批量操作数据时，需要控制事务处理间隔时间，进行必要的sleep，一般建议值5-10秒。</li><li>【建议】对于有<code>auto_increment</code>属性字段的表的插入操作，并发需要控制在200以内。</li><li>【强制】程序设计必须考虑“数据库事务隔离级别”带来的影响，包括脏读、不可重复读和幻读。线上建议事务隔离级别为<code>repeatable-read</code>。</li><li>【建议】事务里包含SQL不超过5个（支付业务除外）。因为过长的事务会导致锁数据较久，MySQL内部缓存、连接消耗过多等雪崩问题。</li><li>【建议】事务里更新语句尽量基于主键或<code>unique key</code>，如<code>update…where id=XX</code>;否则会产生间隙锁，内部扩大锁定范围，导致系统性能下降，产生死锁。</li><li>【建议】尽量把一些典型外部调用移出事务，如调用webservice，访问文件存储等，从而避免事务过长。</li><li>【建议】对于MySQL主从延迟严格敏感的select语句，请开启事务强制访问主库。</li></ol><h3>2.2.4排序和分组</h3><ol><li>【建议】减少使用<code>order by</code>，和业务沟通能不排序就不排序，或将排序放到程序端去做。<code>order by</code>、<code>group by</code>、<code>distinct</code>这些语句较为耗费CPU，数据库的CPU资源是极其宝贵的。</li><li>【建议】<code>order by</code>、<code>group by</code>、<code>distinct</code>这些SQL尽量利用索引直接检索出排序好的数据。如<code>where a=1 order by</code>可以利用<code>key(a,b)</code>。</li><li>【建议】包含了<code>order by</code>、<code>group by</code>、<code>distinct</code>这些查询的语句，where条件过滤出来的结果集请保持在1000行以内，否则SQL会很慢。</li></ol><h3>2.2.5线上禁止使用的SQL语句</h3><ol><li>【高危】禁用<code>update|delete t1…where a=XX limit XX;</code>这种带limit的更新语句。因为会导致主从不一致，导致数据错乱。建议加上<code>order by PK</code>。</li><li>【高危】禁止使用关联子查询，如<code>update t1 set…where name in(select name from user where…);</code>效率极其低下。</li><li>【强制】禁用procedure、function、trigger、views、event、外键约束。因为他们消耗数据库资源，降低数据库实例可扩展性。推荐都在程序端实现。</li><li>【强制】禁用<code>insert into…on duplicate key update…</code>在高并发环境下，会造成主从不一致。</li><li>【强制】禁止联表更新语句，如<code>update t1,t2 where t1.id=t2.id…</code>。</li></ol></div>'
            ].join("")
            layer.open({
                type: 1,
                title: false,
                shadeClose: true,
                shade: false,
                area: ['893px', '600px'],
                content: content
            });
        });
    });
</script>
{% endblock %}
